send_test
POST
/api/v1/accounts/:account_id/webhook_subscriptions/:id/test
Send a test event
Immediately sends a signed webhook.test event to the subscription’s URL and reports what happened, so you can check your endpoint and signature verification without waiting for real activity. Test events are not retried and do not count towards disabling the subscription.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id
|
Must be a number. | Required |
Store (account) ID |
id
|
Must be a number. | Required |
Webhook subscription ID |
Error Codes
| Code | Description |
|---|---|
401
|
Unauthorized – invalid or missing API token |
404
|
Store or subscription not found |
Returns
Code: 200
The outcome of the test delivery
| Name | Type | Required | Description |
|---|---|---|---|
delivered
|
Must be one of: true, false, 1, 0.
|
Required |
True when your URL responded with a 2xx status |
status
|
Must be a Integer | Required |
HTTP status your URL returned (nil allowed) |
event_id
|
Must be a String | Required |
The |
error
|
Must be a String | Required |
Why the delivery failed (nil allowed) |